Subscribe to api Design

1.Expound

After setting the parameters of the current IPC through the WEB, the backend NVR/APP still displays unmodified parameters. In order to achieve real-time updates of backend parameters, subscription APIs are adopted. Subscription API, the backend will inform the frontend of the API used for pages that require real-time parameter updates. If the frontend sets a parameter that matches the subscription content page, it will inform the backend to obtain the parameter for that page.

2.Subscription Content (Scalable)

Table 1

3.Interaction

{width="5.768055555555556in" height="5.174305555555556in"}

When IPC goes online to NVR, NVR calls Login/DeviceInfo/Get, and IPC responds with all subscription APIs currently supported by IPC. The NVR calls Login/SubscribeApi/Set, and its request body is accompanied by the required subscription API or all subscription strings. If the IPC responds OK, it indicates successful subscription. If IPC parameter settings occur, subscribed APIs will be pushed to the backend from/API/Event/Check, and the backend will request the API to obtain parameter data.

4.Protocol formulation

1. Login/DeviceInfo/Get

Response message

Table 2

Table 3

Table 4

Table 5

Request message

Sample:

POST /API/AlarmConfig/Combination/Get HTTP/1.1

{
    "version": "1.0",
    "data": {}
}

Response message

Sample:

HTTP/1.1 200 OK
Content-Type: application/json

"data": {
        "device_main_menu": [
            "localSetting",
            "remoteSetting",
            "playback",
            "preview"
        ],
        "encode_type_ability": [
            "H.264",
            "H.265",
            "H.264+",
            "H.265+"
        ],
        "concentrate_linkage_schedule_ability": ["FloodLight"],
        "ptz_ability": {"btn_autofocus": true},
        "support_subscribe_api": [
            "AlarmConfig/Deterrence/Range",
            "AlarmConfig/Deterrence/Get",
            "StreamConfig/MainStream/Range",
            "StreamConfig/MainStream/Get",
            "StreamConfig/SubStream/Range",
            "StreamConfig/SubStream/Get",
            "StreamConfig/MobileStream/Range",
            "StreamConfig/MobileStream/Get",
            "DeviceConfig/Audio/Range",
            "DeviceConfig/Audio/Get"
        ],
        "support_ai_pidlcd": true,
        "support_face_config": true,
        "support_repeat_visitor": true,
        "support_face_attendance": true,
        "support_human_vehicle_search": true,
        "support_PidLcd_search": true,
        "support_heat_map": true,
        "support_license_plate": true,
        "support_lpd_enhance": true,
        "support_Intrusion_search": true,
        "support_RegionEntrance_search": true,
        "support_RegionExiting_search": true,
        "device_preview_AI_item": [
            "FR",
            "Human",
            "Vehicle",
            "Non-Vehicle",
            "PID_Human",
            "PID_Vehicle",
            "PID_Non-Vehicle",
            "LCD_Human",
            "LCD_Vehicle",
            "LCD_Non-Vehicle",
            "LPR",
            "Intrusion_Human",
            "Intrusion_Vehicle",
            "Intrusion_Non-Vehicle",
            "RegionEntrance_Human",
            "RegionEntrance_Vehicle",
            "RegionEntrance_Non-Vehicle",
            "RegionExiting_Human",
            "RegionExiting_Vehicle",
            "RegionExiting_Non-Vehicle"
        ],
        "support_occlusion_detection": true,
        "device_preview_ability": [
            "face",
            "manual_alarm"
        ],
        "dev_play_backcap": 2,
        "dev_type": 5932089557994242000,
        "device_type": "30KQ+200AI 60FPS 何伟",
        "sound": true,
        "live_sound_disable": {
            "Mainstream": false,
            "Substream": false,
            "Mobilestream": false
        },
        "check_ftp_upgrade": false,
        "support_screen_shots": true,
        "channel_num": 1,
        "stream_profile": {
            "type": "string",
            "items": [
                "Mainstream",
                "Substream",
                "Mobilestream"
            ]
        },
        "default_stream": "Mainstream",
        "support_ftp_upgrade": true,
        "support_http_upgrade": true,
        "support_get_upgradeUrlpw": true,
        "backup_video_encryption_pwd": {
            "type": "string",
            "min_len": 6,
            "max_len": 32
        },
        "support_backup_video_encryption": true,
        "push_type": "RSPush",
        "pushinfo_type": {
            "type": "string",
            "items": []
        },
        "local_alarmin_num": 1,
        "local_alarmout_num": 1,
        "support_ie_down_snap": true,
        "preview_num": 0,
        "mac_addr": "A4-FC-CE-00-14-BE",
        "p2p_id": "DBC4S1NLRUXNHKWL111A",
        "manufacturer": "",
        "support_smart": true,
        "support_smart_record": true,
        "support_substream_playback": false,
        "support_pir_record": false,
        "support_flood_light": true,
        "support_record_tag": true,
        "support_aac": false,
        "support_hls_server": false,
        "support_voice_prompts": true,
        "support_speaker": true,
        "talkback": "TalkFull",
        "support_audio_volume": true,
        "support_sound_record": false,
        "support_manual_record": false,
        "support_video_cover_record": false,
        "support_more_chn_playback": false,
        "support_ai_notification_subscribe": true,
        "ishide_notification_intervalnew_8.2.4": false,
        "support_playback_new_rec_detail": true,
        "support_playback_new_rec_file_download": true,
        "support_io_record": true,
        "support_ANR": true,
        "enable_encryption": true,
        "media_port": 443,
        "media_external_port": 443,
        "upgrade_file_max_size": 128,
        "upgrade_head_trans_size": 3,
        "support_eventchk_snap": true,
        "local_ip": "192.168.1.11",
        "stream_linkage": "normal",
        "FR_model_version": 8388612,
        "FD_model_version": 8456194,
        "support_param_import_export": true,
        "support_sound_detection": true,
        "support_ROI": true,
        "support_record_type_ex": true,
        "support_disarming_onlyset": true,
        "support_recorder_smd": false,
        "support_logcollection": true
    }

2. Login/SubscribeApi/Set

This interface is used to subscribe to the API

Request message

Table 2

Sample:

POST /API/Login/SubscribeApi/Set HTTP/1.1

{
	"version": "1.0",
	"data" : {
" subscribe_api ":[
			"StreamConfig/MainStream/Range",
			"StreamConfig/MainStream/Get",
      "StreamConfig/SubStream/Get",
      "DeviceConfig/Audio/Get",
		]
	}
}

Response message

Sample:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "result": "success",
    "data": {}
}

3. /API/Event/Check

For details seeEvent > Event_check.